feat: add category filtering to commands page sidebar#534
Open
kkonaparthi1 wants to merge 1 commit into
Open
Conversation
Clicking a command category in the sidebar now hides all other command groups, showing only the selected category. Previously, clicking a category only scrolled to the heading while all 200+ commands across 20+ groups remained visible. Changes: - Add hashchange event listener that filters command groups - Add active state styling on the selected sidebar link - Add 'Show All' option to restore the full command list - Clear search box when filtering by category - Filter on initial page load if URL contains a hash Follows the same show/hide pattern used by the existing searchCommands() function. Fixes valkey-io#525 Signed-off-by: Karthik Konaparthi <konapk@amazon.com>
stockholmux
requested changes
Jun 5, 2026
Member
stockholmux
left a comment
stockholmux
left a comment
There was a problem hiding this comment.
Really nice work! A few little UX tweaks needed to make it easily usable.
| {% block related_content %} | ||
| <h2 id="top">Command Categories</h2> | ||
| <ul> | ||
| <li><a href="#top" class="show-all-link active" onclick="window.location.hash='top';">Show All</a></li> |
Member
There was a problem hiding this comment.
The 'Show all' button is active when you don't have any filtering, which is kind of confusing.
Here I'm not filtering, so I'd expect "Show all" to be hidden.
| {% for command_group_name, group_description in group_descriptions %} | ||
| {% set replaced_group_id = command_group_name | replace(from="-", to="_") %} | ||
| {% if grouped[replaced_group_id] %}<li> <a href="#{{ command_group_name }}">{{ group_description.display }}</a></li>{% endif %} | ||
| {% if grouped[replaced_group_id] %}<li> <a href="#{{ command_group_name }}" class="category-link">{{ group_description.display }}</a></li>{% endif %} |
Member
There was a problem hiding this comment.
It would probably make sense to have some sort of indication that you're filtering above the search bar.
For example: "Show only Search commands."
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #525
Summary
Clicking a command category in the sidebar now filters the page to show only that category's commands, instead of just scrolling to the heading while all 200+ commands remain visible.
Changes
hashchangeevent listener that hides all command groups except the selected oneApproach
Follows the same show/hide pattern already used by the existing
searchCommands()function. ~30 lines of JavaScript + 5 lines of SCSS.